Repository navigation
docs: open each module's readme with its install, a framework example and a prompt for an assistant - #67
Merged
Conversation
… a framework example
… guessing its api
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GitHub Packages shows no README for a Maven package, only a Maven snippet and "No description available yet", so a reader landing there or in a module folder had to go to
.docs/install.mdfor the dependency line and to.docs/usage.mdfor a first call.Each module's README now opens with:
.docs/install.mdfor the repository block and the token;Paymentsbean in that framework's idiom (@Service,jakarta.inject.Singleton,@ApplicationScoped, Play'sjavax.inject), with its imports, reading the money received and booked over the last week throughmoneta.with(token); Kotlin collapsed beside Java, except for Play. Under it: what happens with several accounts or without the token property.For a coding assistant:
llms.txtat the root (the setup and the mistakes to avoid, linked from the README), and a prompt to paste in each module's README, naming that module's artifact, configuration and README, written for no tool in particular.Play's pool example now calls that bean instead of
moneta.incoming(…)with undefined arguments.modules/moneta-api/README.mdis new, the same for the plain client. Beside the new text: "merchants" became "account holders", the long dash in the property tables "none"..docs/install.mdnames 0.2.0, andmake publish-localnow installs0.3.0-SNAPSHOTinstead of0.1.0-SNAPSHOT, which sorted below the released version.The version is written in five more places;
make releasedoes not bump them, so each release edits them by hand until it does.